home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / othernet / fidonet / dip / dipinstr.txt < prev    next >
Text File  |  1993-10-27  |  23KB  |  619 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.           D O O R    I N T E R F A C E    P R O G R A M
  18.                              (DIP)
  19.                     Version 1.6 User's Manual
  20.               Copyright (c) 1990-93 by Jeff Fehlman
  21.                        All rights reserved.
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.                          19 January,  1993
  45.  
  46.                          MindKeep Software
  47.                            Jeff Fehlman
  48.                            PO Box  5332
  49.                      Fair Oaks, CA 95628-9106
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.                T A B L E    O F    C O N T E N T S 
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65. Introduction................................................  3
  66.   Description
  67.   The Shareware Plea
  68.   Warranty and Disclaimer
  69.   Registration and Benefits
  70.   Obtaining Updates
  71. Getting Started.............................................  5
  72. DIP Configuration...........................................  5
  73.   Main SysOp Menu
  74.   Select Input Method to DIP Menu
  75. Door Configuration..........................................  7
  76.   Door Selection Menu
  77.   Door Edit Menu
  78.   Select Desired Groups for Access Menu
  79. DIP Graphics Modes.......................................... 10
  80. Appendix.................................................... 11
  81.   DIP Color Graphic Codes
  82.   DIP Group Integer Field
  83.   DIP/ST-KEEP Input User File Format
  84.   DIP DORINFO1 Input File Format
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111. Description:
  112.  
  113.     The Door Interface Program (DIP) is an on-line menuing
  114.  system designed to allow on-line games and programs to be exe-
  115.  cuted from within most BBS software.  It features complete log-
  116.  ging capabilities, VT-52, ANSI and ASCII graphics and a user
  117.  friendly GEM SysOp interface.
  118.  
  119. DIP may receive it's input in a variety of ways:
  120.  
  121.     Direct User Input
  122.     Command Line Parameters
  123.     Special ST-Keep User File
  124.      DORINFO1.DEF File
  125.  
  126. DIP will output the following formats while launching a program:
  127.  
  128.     Command Line Parameters
  129.     FOREM.DAT File
  130.     DORINFO1.DEF File
  131.     Simple ASCII User name File
  132.  
  133.  
  134. The Shareware Plea:
  135.  
  136.        Shareware is commercial (or near commercial) software
  137.  distributed in an unconventional manner.  Anyone may copy a
  138.  Shareware program and distribute it to whomever they desire, 
  139.  provided they do not charge a fee or alter it in any way.
  140.  Shareware isn't free.  Serious Shareware represents just as
  141.  much programming effort as any conventional commercial product.
  142.  If you use it regularly, the authors expect compensation.
  143.  Unlike commercial distribution, Shareware allows you to
  144.  evaluate the product before you decide to purchase it.  The
  145.  price is often lower, as well, because there are no adver-
  146.  tising, packaging, or distribution costs.  It can only work
  147.  with your support.  If you are still using a Shareware pro-
  148.  duct after a couple of weeks, then it is obviously worth
  149.  something to you, and you should register it.
  150.  
  151.     DIP is distributed as Shareware.  This means that
  152.  users are encouraged, subject to restrictions described above,
  153.  to share copies of this program with friends, associates and
  154.  bulletin boards.  Please remember that if you use this soft-
  155.  ware you are required to pay the registration fee of either
  156.  $10.00 or $15.00 depending upon your delivery method as
  157.  described in the section titled Registration Fee.  DIP may
  158.  NOT be sold or included with a commercial product without
  159.  the express written consent of the author.  Also, this
  160.  documentation may not be reprinted without the express
  161.  written consent of the author.   
  162.  
  163.  
  164.  
  165.  
  166. Warranty and Disclaimer:
  167.  
  168.     MindKeep Software and Jeff Fehlman specifically dis-
  169.  claims all warranties, expressed or implied, including but not
  170.  limited to implied warranties of merchantability and fitness
  171.  for a particular purpose with respect to defects in the pro-
  172.  grams and documentation. In no event shall MindKeep Software
  173.  and Jeff Fehlman be liable for any loss of profit or any other
  174.  commercial damage, including but not limited to special, in-
  175.  cidental, consequential or other damages.
  176.  
  177.      Jeff Fehlman retains all rights to the DIP Package and
  178.  the right to make updates to this package and its documentation
  179.  without notification to the purchaser.  This package is sold
  180.  and distributed "as is".
  181.  
  182.  
  183. Registration and Benefits:
  184.  
  185.   You may register DIP in either of two ways:
  186.  
  187.     1)  Send $15.00 and the registration form to the address
  188.         indicated.  You will be sent a 3 1/2" disk containing
  189.         the latest version of DIP and a key file to register
  190.         your copy of DIP.
  191.  
  192.     2)  Send $10.00 and the registration form to the address
  193.         indicated.  In a few weeks call the DIP Support BBS
  194.         and download your registered program yourself.
  195.  
  196.  
  197. Obtaining Updates:
  198.  
  199.     Updates and Product Support may be best obtained by
  200.  calling the DIP Support BBS (FREQ DIP):
  201.  
  202.                        =-=-=-=-=-=-=-=-=-=
  203.                           The Mind Keep
  204.                          (916)  723-1657
  205.                         1200 - 14.4K baud
  206.                        =-=-=-=-=-=-=-=-=-=
  207.                       AtariNet    51:3/13.0
  208.                       FidoNet  1:203/1657.0
  209.                       NeST    90:300/1657.0
  210.                       TurboNet 100:290/10.0
  211.                       PixNet  116:204/140.0
  212.  
  213.  I may also be reached via GEnie address J.FEHLMAN
  214.  and InterNet (query NIC).
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221. Getting Started:
  222.  
  223.     First, create a folder in which DIP and it's associated
  224.  files will reside.  Copy DIP.TTP and DIPSYSOP.PRG into this
  225.  folder.  Before running DIP you must have a modem connected to
  226.  your system and turned on.  Make sure the modem is set to the
  227.  Hayes AT&C1 command (cause DCD to track actual state of remote
  228.  modem's carrier).
  229.  
  230.     Run DIP.TTP by double clicking on it.  There is no need
  231.  to enter command line parameters.  The title screen will come
  232.  up and DIP will ask for your name.  Enter any name here.  DIP
  233.  will ask for conformation and then ask for your Graphics mode.
  234.  Enter either ASCII or VT-52.
  235.  
  236.     At this point you will see a menu with two entries, 'M'
  237.  for maintenance and 'X' for exit.  Press 'M' and the SysOp
  238.  Maintenance program will start.  You are ready to configure DIP.
  239.  
  240.  
  241. Main SysOp Menu:
  242.  
  243.     The Main SysOp menu is the opening menu to configure DIP
  244.  for your system.  It is accessed by typing 'M' from the DIP
  245.  menu.
  246.  
  247.   Edit Door:   Calls the Door Selection Menu which allows you
  248.                to create, delete, edit and move menu entries.
  249.   Save:        Saves your work and exits the SysOp Maintenance
  250.                Program.
  251.   Exit:        Exits the SysOp Maintenance Program but DOES NOT
  252.                save your work.
  253.   Time Limit:  Enter the maximum amount of time you wish to
  254.                allow users in this menu.
  255.   Menu Title:  Enter the title of your menu.
  256.   
  257.   Configuration Switches:
  258.     
  259.     Display BBS Name:         Display your BBS name the first
  260.                               time a user enters the menu.
  261.     Display Bulletin:         Display a specified text file the
  262.                               first time a user enters the menu
  263.                               (you must specify the name and
  264.                               path of the Bulletin file in the 
  265.                               box beside this switch, see 
  266.                               details elsewhere).
  267.     Display Welcome Message:  Display "Welcome <USER NAME>" the
  268.                               first time a user enters the menu.
  269.     Record LOG File:          Keeps a log file of the users
  270.                               actions (you must specify a name
  271.                               and path of the Log file in the
  272.                               box beside this switch.  In
  273.                               addition, you must initialize the
  274.                               log file if it does not already
  275.                               exist, see details elsewhere).
  276.     Initialize LOG File:      Destroy the old log file (if any)
  277.                               and  create a new one.
  278.     Select DIP Input:         Calls the "Select Input Method to
  279.                               DIP" menu, see details elsewhere
  280.                               (VERY IMPORTANT!).
  281.  
  282.   Specify Bulletin path/name: Pressing 'Yes' will display the
  283.                               file selector and allow you to
  284.                               choose a Bulletin (text) file name
  285.                               and path for display to the user
  286.                               immediately after DIP starts exe-
  287.                               cuting.  This is only necessary if
  288.                               you have selected the 'Display 
  289.                               Bulletin' switch (see details
  290.                               elsewhere).
  291.   Specify LOG file path/name: Pressing 'Yes' will display the
  292.                               file selector and allow you to
  293.                               choose a log file name and path to
  294.                               record user activities while in
  295.                               DIP.  This is only necessary if
  296.                               you have selected the 'Record LOG
  297.                               File' switch (see details else-
  298.                               where).  In addition, you must
  299.                               initialize the log file if it does
  300.                               not already exist (see details
  301.                               elsewhere).
  302.  
  303.  
  304. Select Input Method to DIP Menu:
  305.  
  306.     The 'Select Input Method to DIP' menu allows you to
  307.  specify which method DIP will use to input user information.
  308.  Not entering this information will cause DIP to default to 
  309.  'User Query' mode.  Entry is from the Main SysOp Menu.
  310.  
  311.   Configuration Switches:
  312.  
  313.     User Query:          DIP will query the user about their
  314.                          name and graphics mode when DIP is
  315.                          first executed.  This provides only
  316.                          minimal information.  The user's time
  317.                          limit is taken from the time the user 
  318.                          enters the DIP program.  The user is
  319.                          placed in 'Group 1' (more information
  320.                          on this elsewhere).
  321.     Command Line Input:  DIP will read it's command line for the
  322.                          user's name.  It will still query the
  323.                          user for their graphics mode.  The 
  324.                          user's time limit is taken from the
  325.                          time the user enters the DIP program.
  326.                          The user is placed in 'Group 1' (more
  327.                          information on this elsewhere).
  328.  
  329.  
  330.  
  331.     User File Input:     The author of ST-Keep BBS, Andrew 
  332.                          Studer, has provided DIP with an ASCII
  333.                          format file containing all of the in-
  334.                          formation need for DIP to operate ef-
  335.                          ficiently.  You will need to specify
  336.                          the file name and path in the box below
  337.                          this switch (make sure this corresponds
  338.                          with ST-Keep's name and path!).  
  339.                          Details on the format of this file may
  340.                          be found in the Appendix.
  341.     DORINFO1 Input:      DIP will read a DORINFO1.DEF file and
  342.                          extract the necessary user information
  343.                          from it.  You will need to specify the
  344.                          file path in the box below this switch
  345.                          (make sure this corresponds with your
  346.                          BBS system's path!).  Details on the
  347.                          format of this file may be found in the
  348.                          Appendix.
  349.  
  350.   Specify Input File Path/Name:  Pressing 'Yes' will display the
  351.                                  file selector and allow you to
  352.                                  choose either a user file name
  353.                                  and path or a DORINFO1 path.
  354.                                  This field MUST be used either
  355.                                  the 'User File Input' or
  356.                                  'DORINFO1 Input' is selected.
  357.  
  358.   Exit:  Returns DIP to the Main SysOp Menu.
  359.  
  360.  
  361. Door Selection Menu:
  362.  
  363.      This menu allows you to create, delete, edit and move
  364.  menu entries.  It is entered from the Main SysOp menu.
  365.  
  366.   Menu Item Selection:
  367.  
  368.     The left side of the Door Selection menu contains a list
  369.    of existing menu entries.  You may select a menu item either
  370.    by selecting the menu title or it's corresponding letter
  371.    designation.
  372.  
  373.   Create:  Calls the 'Door Edit Menu' to create and edit a new
  374.            menu item.  It is not necessary to choose an existing
  375.            menu item.
  376.   Delete:  Deletes an item from the menu.  You must select a
  377.            menu item either before or after activating this
  378.            switch.  Selecting 'Cancel' aborts this operation.
  379.   Edit:    Calls the 'Door Edit Menu' to edit an existing menu
  380.            item.  You must select a menu item either before or
  381.            after activating this switch.  Selecting 'Cancel'
  382.            aborts this operation.
  383.   Move:    Changes the order of appearance of the menu items.
  384.            You must select a menu item either before or after
  385.            activating this switch.  DIP will prompt you for the
  386.            'Destination' location.  Simply choose your new
  387.            location in the Menu Item Selection area (see details
  388.            elsewhere) and the menu item will be moved to that
  389.            location.  Selecting 'Cancel' at any time aborts this
  390.            operation.
  391.   Cancel:  Returns DIP to the Main SysOp Menu.
  392.  
  393.  
  394. Door Edit Menu:
  395.  
  396.     The Door Edit Menu specifies all the necessary parameters
  397.  to run a given menu item.  It is entered from the Door 
  398.  Selection Menu.
  399.  
  400.   Title:  Enter the title of your menu item.
  401.   Save:   Saves your work and exits to the Door Selection Menu.
  402.   Exit:   Exits to the Door Selection Menu but DOES NOT save
  403.           your work.
  404.  
  405.   Configuration Switches:
  406.  
  407.     Console ONLY:  Menu item is only executable (and visible)
  408.                    when DIP is in 'local' or 'console' mode.
  409.     LOG Program:   Allows logging of activity in this menu item.
  410.                    The Record LOG File switch (see the Main
  411.                    SysOp Menu description previously in this
  412.                    manual) must be switched on for this to have
  413.                    any effect.
  414.     Send LOCAL:    Sends 'LOCAL' across the command line to the
  415.                    menu item when evoking that program while in
  416.                    console mode. This overrides any command line
  417.                    parameters specified in the Specify Command
  418.                    Line field (see elsewhere).
  419.  
  420.   Group:  Calls the 'Select Desired Groups for Access' menu.  If
  421.           not specified, a default group of '1' is specified
  422.           (see below for details).
  423.  
  424.   Select Emulation:
  425.  
  426.     DORINFO1:  Selects the DORINFO1.DEF File Format.  DIP will
  427.                write a DORINFO1.DEF file to the location
  428.                specified by the 'Specify Data File Path/Name'
  429.                field (described below) when the menu item is
  430.                launched.
  431.     FOREM:     Selects the FOREM.DAT File Format.  DIP will
  432.                write a FOREM.DAT file to the location specified
  433.                by the 'Specify Data File Path/Name' field
  434.                (described below) when the menu item is launched.
  435.     TEXT:      Selects the Text File mode.  DIP will output the
  436.                file specified in the 'Specify Program File Path/
  437.                Name' field (described elsewhere) directly to the
  438.                screen/modem when the menu item is launched.
  439.  
  440.  
  441.     USERNAME:  Selects a simple ASCII User Name File Format.
  442.                DIP will write an ASCII user name file specified
  443.                by the 'Specify Data File Path/Name' field
  444.                (described elsewhere) when the menu item is 
  445.                launched.  The file contains the user's name on
  446.                the first line and the user's time remaining on
  447.                the last line.
  448.     DIP MENU:  Selects the DIP sub menu option.  This allows
  449.                creation of menus within the main DIP menu.  You
  450.                must specify the name and path of the menu file
  451.                in the 'Specify Data File Path/Name field'
  452.                (described elsewhere).  This option is only
  453.                available in registered versions of DIP.
  454.     NONE:      Specifies that no data files are to be written
  455.                when this menu item is launched.
  456.  
  457.   Specify Program Path/Name:    Pressing 'Yes' will display the
  458.                                 file selector and allow you to
  459.                                 choose the file/program that you
  460.                                 wish to correspond with the menu
  461.                                 item and launch.
  462.   Specify Command Line:         Pressing 'Yes' will allow you to
  463.                                 specify a command line to be
  464.                                 passed when the menu item is
  465.                                 launched.  Putting a "#" in the
  466.                                 command line followed by any
  467.                                 letter ("U" is used internally)
  468.                                 will cause DIP to output the
  469.                                 user's name.  You may have up to
  470.                                 40 characters in this field.  If
  471.                                 more is desired you must manual-
  472.                                 ly edit the data file cor-
  473.                                 responding with this menu item
  474.                                 entry.
  475.   Specify Data File Path/Name:  Pressing 'Yes' will display the
  476.                                 file selector and allow you to
  477.                                 choose the  data file path (for
  478.                                 DORINFO1 and FOREM emulation)
  479.                                 and data file path/name (for
  480.                                 ASCII user file emulation types
  481.                                 and DIP sub menu types) that you
  482.                                 wish to correspond with the menu
  483.                                 item and launch.
  484.  
  485.  
  486. Select Desired Groups for Access Menu:
  487.  
  488.     The Select Desired Groups for Access menu allows you to
  489.  specify user group access to DIP menu items.  Default group
  490.  access is '1'.  It is entered from the Door Edit Menu.  Group
  491.  access options may be utilized only when using the ST-Keep User
  492.  File or DORINFO1 DIP Input Method selections.  Otherwise it
  493.  should always be '1'.  If no groups switches are turned on then
  494.  ALL users may access that menu item.  For more information on
  495.  the Group access integer see the Appendix.
  496.  
  497.   Configuration Switches:
  498.  
  499.     Group 01:      Simply turn on/off the user groups you wish
  500.        :           to grant/deny access.
  501.        :
  502.     Group 15:
  503.     Console Only:  Specifies this menu item may only be run from
  504.                    the console or local mode.  Same as the 
  505.                    'Console Only' switch in the Door Edit menu.
  506.  
  507.   Exit:  Exits to the Door Edit menu.
  508.  
  509.  
  510. DIP Graphics Modes:
  511.  
  512.     DIP has the ability to emulate ASCII, Atari VT-52 and
  513.  ANSI graphics modes.  The user's current graphic mode is ob-
  514.  tained from the DORINFO1 or ST-Keep User File Input Methods or
  515.  directly from the user at run time.  The user may change their
  516.  graphics mode by typing '!' at the DIP menu prompt.  You may
  517.  create text files and bulletins using these graphics modes by
  518.  imbedding the proper escape code sequence into the text file to
  519.  be displayed.  Refer to the Appendix for the exact codes DIP
  520.  will reconize.
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542. Thank you for your interest in the Door Interface Program. 
  543. If you have any questions or problems please feel free to
  544. call the MindKeep and leave me a message.  I will get back
  545. to you ASAP and if that dosn't work call Pres. Clinton, he
  546. said he would listen to the people!  (he he he)
  547.  
  548.  
  549.  
  550.  
  551.  
  552.                            A P P E N D I X
  553.  
  554.  
  555.  
  556. DIP Color Graphic Codes:
  557.  
  558.          <ESC>00         Black foreground
  559.          <ESC>01         Red foreground
  560.          <ESC>04         Blue foreground (green in VT-52)
  561.          <ESC>07         White foreground
  562.          <ESC>08         Black background
  563.          <ESC>09         Red background
  564.          <ESC>12         Blue background (green in VT-52)
  565.          <ESC>15         White background
  566.          <ESC>18         Erase screen
  567.  
  568.   NOTE:  The <ESC> symbol denotes the ASCII 27.
  569.  
  570.  
  571. DIP Group Integer Field:
  572.  
  573.     The DIP group field is an integer divided into 16 bits.
  574.  Each bit corresponds a given group as specified below:
  575.  
  576.  msb                                            lsb
  577.   15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
  578.    |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  +- Group  1
  579.    |  |  |  |  |  |  |  |  |  |  |  |  |  |  +---- Group  2
  580.    |  |  |  |  |  |  |  |  |  |  |  |  |  +------- Group  3
  581.    |  |  |  |  |  |  |  |  |  |  |  |  +---------- Group  4
  582.    |  |  |  |  |  |  |  |  |  |  |  +------------- Group  5
  583.    |  |  |  |  |  |  |  |  |  |  +---------------- Group  6
  584.    |  |  |  |  |  |  |  |  |  +------------------- Group  7
  585.    |  |  |  |  |  |  |  |  +---------------------- Group  8
  586.    |  |  |  |  |  |  |  +------------------------- Group  9
  587.    |  |  |  |  |  |  +---------------------------- Group 10
  588.    |  |  |  |  |  +------------------------------- Group 11
  589.    |  |  |  |  +---------------------------------- Group 12
  590.    |  |  |  +------------------------------------- Group 13
  591.    |  |  +---------------------------------------- Group 14
  592.    |  +------------------------------------------- Group 15
  593.    +---------------------------------------------- Group 16
  594.                                                   (Console Mode)
  595.  
  596.  
  597. DIP/ST-KEEP Input User File Format:
  598.  
  599.   LINE  1:  User's Name
  600.   LINE  2:  User's Graphics Mode 
  601.   LINE  3:  User's Group Number
  602.   LINE  4:  User's Time Left
  603.  
  604.  
  605.  
  606. DIP DORINFO1 Input File Format:
  607.  
  608.   LINE  1:  BBS Name
  609.   LINE  2:  SysOp's First Name
  610.   LINE  3:  SysOp's Last Name
  611.   LINE  4:  unused by DIP
  612.   LINE  5:  Baud Rate
  613.   LINE  6:  User's First Name
  614.   LINE  7:  User's Last Name
  615.   LINE  8:  User's City/State
  616.   LINE  9:  User's Graphics Mode
  617.   LINE 10:  User's Group Number
  618.   LINE 11:  User's Time Left
  619.